<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Sets a quota for a given mailbox</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.imap-set-quota" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_set_quota</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.5, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_set_quota</span> &mdash; <span class="dc-title">Sets a quota for a given mailbox</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-set-quota-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_set_quota</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$quota_root</code></span>
   , <span class="methodparam"><span class="type">int</span> <code class="parameter">$quota_limit</code></span>
   ) : <span class="type">bool</span></div>

  <p class="para rdfs-comment">
   Sets an upper limit quota on a per mailbox basis. 
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-set-quota-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    <dt>
<code class="parameter">
imap_stream</code></dt>
<dd>
<p class="para">由 <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</p></dd>

    
     <dt>
<code class="parameter">quota_root</code></dt>

     <dd>

      <p class="para">
       The mailbox to have a quota set. This should follow the IMAP standard
       format for a mailbox: <em>user.name</em>.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">quota_limit</code></dt>

     <dd>

      <p class="para">
       The maximum size (in KB) for the <code class="parameter">quota_root</code>
      </p>
     </dd>

    
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-set-quota-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.imap-set-quota-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-4037">
    <p><strong>Example #1 <span class="function"><strong>imap_set_quota()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$mbox&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"mailadmin"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br />if&nbsp;(!</span><span style="color: #0000BB">imap_set_quota</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"user.kalowsky"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">3000</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Error&nbsp;in&nbsp;setting&nbsp;quota\n"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;return;<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
    </div>

   </div>
  </p>
 </div>

 <div class="refsect1 notes" id="refsect1-function.imap-set-quota-notes">
  <h3 class="title">注释</h3>
  <p class="para">
   This function is currently only available to users of the c-client2000
   or greater library.
  </p>
  <p class="para">
   The given <code class="parameter">imap_stream</code> must be opened as the mail
   administrator, other wise this function will fail.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.imap-set-quota-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="imap_open.html" class="function" rel="rdfs-seeAlso">imap_open()</a> - Open an IMAP stream to a mailbox</span></li>
    <li class="member"><span class="function"><a href="imap_get_quota.html" class="function" rel="rdfs-seeAlso">imap_get_quota()</a> - Retrieve the quota level settings, and usage statics per mailbox</span></li>
   </ul>
  </p>
 </div>

</div></div></div></body></html>